home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 2 / AACD 2.iso / AACD / Programming / Perl / bin / perlbug < prev    next >
Text File  |  1990-01-01  |  31KB  |  1,024 lines
  1. #!/gg/bin/perl
  2.     eval 'exec /gg/bin/perl -S $0 ${1+"$@"}'
  3.     if $running_under_some_shell;
  4.  
  5. my $config_tag1 = '5.00502 - Fri May 21 23:02:59 MST 1999';
  6.  
  7. my $patchlevel_date = 914811979;
  8. my $patch_tags = '';
  9. my @patches = (
  10.     ''
  11. );
  12.  
  13. use Config;
  14. use Getopt::Std;
  15. use strict;
  16.  
  17. sub paraprint;
  18.  
  19. BEGIN {
  20.     eval "use Mail::Send;";
  21.     $::HaveSend = ($@ eq "");
  22.     eval "use Mail::Util;";
  23.     $::HaveUtil = ($@ eq "");
  24. };
  25.  
  26. my $Version = "1.26";
  27.  
  28. # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
  29. # Changed in 1.07 to see more sendmail execs, and added pipe output.
  30. # Changed in 1.08 to use correct address for sendmail.
  31. # Changed in 1.09 to close the REP file before calling it up in the editor.
  32. #                 Also removed some old comments duplicated elsewhere.
  33. # Changed in 1.10 to run under VMS without Mail::Send; also fixed
  34. #                 temp filename generation.
  35. # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
  36. # Changed in 1.12 to check for editor errors, make save/send distinction
  37. #                 clearer and add $ENV{REPLYTO}.
  38. # Changed in 1.13 to hopefully make it more difficult to accidentally
  39. #                 send mail
  40. # Changed in 1.14 to make the prompts a little more clear on providing
  41. #                 helpful information. Also let file read fail gracefully.
  42. # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
  43. #                 Also report selected environment variables.
  44. # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
  45. # Changed in 1.17 Win32 support added.  GSAR 97-04-12
  46. # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
  47. # Changed in 1.19 '-ok' default not '-v'
  48. #                 add local patch information
  49. #                 warn on '-ok' if this is an old system; add '-okay'
  50. # Changed in 1.20 Added patchlevel.h reading and version/config checks
  51. # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
  52. # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
  53. # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
  54. # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
  55. # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
  56. # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
  57.  
  58. # TODO: - Allow the user to re-name the file on mail failure, and
  59. #       make sure failure (transmission-wise) of Mail::Send is
  60. #       accounted for.
  61. #       - Test -b option
  62.  
  63. my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
  64.     $subject, $from, $verbose, $ed, $outfile,
  65.     $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
  66.  
  67. my $config_tag2 = "$] - $Config{cf_time}";
  68.  
  69. Init();
  70.  
  71. if ($::opt_h) { Help(); exit; }
  72. if ($::opt_d) { Dump(*STDOUT); exit; }
  73. if (!-t STDIN && !($ok and not $::opt_n)) {
  74.     paraprint <<EOF;
  75. Please use perlbug interactively. If you want to
  76. include a file, you can use the -f switch.
  77. EOF
  78.     die "\n";
  79. }
  80. if (!-t STDOUT && !$outfile) { Dump(*STDOUT); exit; }
  81.  
  82. Query();
  83. Edit() unless $usefile || ($ok and not $::opt_n);
  84. NowWhat();
  85. Send();
  86.  
  87. exit;
  88.  
  89. sub Init {
  90.     # -------- Setup --------
  91.  
  92.     $Is_MSWin32 = $^O eq 'MSWin32';
  93.     $Is_VMS = $^O eq 'VMS';
  94.  
  95.     if (!getopts("dhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
  96.  
  97.     # This comment is needed to notify metaconfig that we are
  98.     # using the $perladmin, $cf_by, and $cf_time definitions.
  99.  
  100.     # -------- Configuration ---------
  101.  
  102.     # perlbug address
  103.     $perlbug = 'perlbug@perl.com';
  104.  
  105.     # Test address
  106.     $testaddress = 'perlbug-test@perl.com';
  107.  
  108.     # Target address
  109.     $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
  110.  
  111.     # Users address, used in message and in Reply-To header
  112.     $from = $::opt_r || "";
  113.  
  114.     # Include verbose configuration information
  115.     $verbose = $::opt_v || 0;
  116.  
  117.     # Subject of bug-report message
  118.     $subject = $::opt_s || "";
  119.  
  120.     # Send a file
  121.     $usefile = ($::opt_f || 0);
  122.  
  123.     # File to send as report
  124.     $file = $::opt_f || "";
  125.  
  126.     # File to output to
  127.     $outfile = $::opt_F || "";
  128.  
  129.     # Body of report
  130.     $body = $::opt_b || "";
  131.  
  132.     # Editor
  133.     $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
  134.     || ($Is_VMS && "edit/tpu")
  135.     || ($Is_MSWin32 && "notepad")
  136.     || "vi";
  137.  
  138.     # Not OK - provide build failure template by finessing OK report
  139.     if ($::opt_n) {
  140.     if (substr($::opt_n, 0, 2) eq 'ok' )    {
  141.         $::opt_o = substr($::opt_n, 1);
  142.     } else {
  143.         Help();
  144.         exit();
  145.     }
  146.     }
  147.  
  148.     # OK - send "OK" report for build on this system
  149.     $ok = 0;
  150.     if ($::opt_o) {
  151.     if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
  152.         my $age = time - $patchlevel_date;
  153.         if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
  154.         my $date = localtime $patchlevel_date;
  155.         print <<"EOF";
  156. "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
  157. are more than 60 days old.  This Perl version was constructed on
  158. $date.  If you really want to report this, use
  159. "perlbug -okay" or "perlbug -nokay".
  160. EOF
  161.         exit();
  162.         }
  163.         # force these options
  164.         unless ($::opt_n) {
  165.         $::opt_S = 1; # don't prompt for send
  166.         $::opt_b = 1; # we have a body
  167.         $body = "Perl reported to build OK on this system.\n";
  168.         }
  169.         $::opt_C = 1; # don't send a copy to the local admin
  170.         $::opt_s = 1; # we have a subject line
  171.         $subject = ($::opt_n ? 'Not ' : '')
  172.             . "OK: perl $] ${patch_tags}on"
  173.             ." $::Config{'archname'} $::Config{'osvers'} $subject";
  174.         $ok = 1;
  175.     } else {
  176.         Help();
  177.         exit();
  178.     }
  179.     }
  180.  
  181.     # Possible administrator addresses, in order of confidence
  182.     # (Note that cf_email is not mentioned to metaconfig, since
  183.     # we don't really want it. We'll just take it if we have to.)
  184.     #
  185.     # This has to be after the $ok stuff above because of the way
  186.     # that $::opt_C is forced.
  187.     $cc = $::opt_C ? "" : (
  188.     $::opt_c || $::Config{'perladmin'}
  189.     || $::Config{'cf_email'} || $::Config{'cf_by'}
  190.     );
  191.  
  192.     # My username
  193.     $me = $Is_MSWin32 ? $ENV{'USERNAME'}
  194.         : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
  195.         : eval { getpwuid($<) };    # May be missing
  196.  
  197.     $from = $::Config{'cf_email'}
  198.        if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
  199.                ($me eq $::Config{'cf_by'});
  200. } # sub Init
  201.  
  202. sub Query {
  203.     # Explain what perlbug is
  204.     unless ($ok) {
  205.     paraprint <<EOF;
  206. This program provides an easy way to create a message reporting a bug
  207. in perl, and e-mail it to $address.  It is *NOT* intended for
  208. sending test messages or simply verifying that perl works, *NOR* is it
  209. intended for reporting bugs in third-party perl modules.  It is *ONLY*
  210. a means of reporting verifiable problems with the core perl distribution,
  211. and any solutions to such problems, to the people who maintain perl.
  212.  
  213. If you're just looking for help with perl, try posting to the Usenet
  214. newsgroup comp.lang.perl.misc.  If you're looking for help with using
  215. perl with CGI, try posting to comp.infosystems.www.programming.cgi.
  216. EOF
  217.     }
  218.  
  219.     # Prompt for subject of message, if needed
  220.     unless ($subject) {
  221.     paraprint <<EOF;
  222. First of all, please provide a subject for the
  223. message. It should be a concise description of
  224. the bug or problem. "perl bug" or "perl problem"
  225. is not a concise description.
  226. EOF
  227.     print "Subject: ";
  228.     $subject = <>;
  229.  
  230.     my $err = 0;
  231.     while ($subject !~ /\S/) {
  232.         print "\nPlease enter a subject: ";
  233.         $subject = <>;
  234.         if ($err++ > 5) {
  235.         die "Aborting.\n";
  236.         }
  237.     }
  238.     chop $subject;
  239.     }
  240.  
  241.     # Prompt for return address, if needed
  242.     unless ($from) {
  243.     # Try and guess return address
  244.     my $guess;
  245.  
  246.     $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
  247.     unless ($guess) {
  248.         my $domain;
  249.         if ($::HaveUtil) {
  250.         $domain = Mail::Util::maildomain();
  251.         } elsif ($Is_MSWin32) {
  252.         $domain = $ENV{'USERDOMAIN'};
  253.         } else {
  254.         require Sys::Hostname;
  255.         $domain = Sys::Hostname::hostname();
  256.         }
  257.         if ($domain) {
  258.         if ($Is_VMS && !$::Config{'d_socket'}) {
  259.             $guess = "$domain\:\:$me";
  260.         } else {
  261.             $guess = "$me\@$domain" if $domain;
  262.         }
  263.         }
  264.     }
  265.  
  266.     if ($guess) {
  267.         unless ($ok) {
  268.         paraprint <<EOF;
  269. Your e-mail address will be useful if you need to be contacted. If the
  270. default shown is not your full internet e-mail address, please correct it.
  271. EOF
  272.         }
  273.     } else {
  274.         paraprint <<EOF;
  275. So that you may be contacted if necessary, please enter
  276. your full internet e-mail address here.
  277. EOF
  278.     }
  279.  
  280.     if ($ok && $guess) {
  281.         # use it
  282.         $from = $guess;
  283.     } else {
  284.         # verify it
  285.         print "Your address [$guess]: ";
  286.         $from = <>;
  287.         chop $from;
  288.         $from = $guess if $from eq '';
  289.     }
  290.     }
  291.  
  292.     if ($from eq $cc or $me eq $cc) {
  293.     # Try not to copy ourselves
  294.     $cc = "yourself";
  295.     }
  296.  
  297.     # Prompt for administrator address, unless an override was given
  298.     if( !$::opt_C and !$::opt_c ) {
  299.     paraprint <<EOF;
  300. A copy of this report can be sent to your local
  301. perl administrator. If the address is wrong, please
  302. correct it, or enter 'none' or 'yourself' to not send
  303. a copy.
  304. EOF
  305.     print "Local perl administrator [$cc]: ";
  306.     my $entry = scalar <>;
  307.     chop $entry;
  308.  
  309.     if ($entry ne "") {
  310.         $cc = $entry;
  311.         $cc = '' if $me eq $cc;
  312.     }
  313.     }
  314.  
  315.     $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
  316.     $andcc = " and $cc" if $cc;
  317.  
  318.     # Prompt for editor, if no override is given
  319. editor:
  320.     unless ($::opt_e || $::opt_f || $::opt_b) {
  321.     paraprint <<EOF;
  322. Now you need to supply the bug report. Try to make
  323. the report concise but descriptive. Include any
  324. relevant detail. If you are reporting something
  325. that does not work as you think it should, please
  326. try to include example of both the actual
  327. result, and what you expected.
  328.  
  329. Some information about your local
  330. perl configuration will automatically be included
  331. at the end of the report. If you are using any
  332. unusual version of perl, please try and confirm
  333. exactly which versions are relevant.
  334.  
  335. You will probably want to use an editor to enter
  336. the report. If "$ed" is the editor you want
  337. to use, then just press Enter, otherwise type in
  338. the name of the editor you would like to use.
  339.  
  340. If you would like to use a prepared file, type
  341. "file", and you will be asked for the filename.
  342. EOF
  343.     print "Editor [$ed]: ";
  344.     my $entry =scalar <>;
  345.     chop $entry;
  346.  
  347.     $usefile = 0;
  348.     if ($entry eq "file") {
  349.         $usefile = 1;
  350.     } elsif ($entry ne "") {
  351.         $ed = $entry;
  352.     }
  353.     }
  354.  
  355.     # Generate scratch file to edit report in
  356.     $filename = filename();
  357.  
  358.     # Prompt for file to read report from, if needed
  359.     if ($usefile and !$file) {
  360. filename:
  361.     paraprint <<EOF;
  362. What is the name of the file that contains your report?
  363. EOF
  364.     print "Filename: ";
  365.     my $entry = scalar <>;
  366.     chop $entry;
  367.  
  368.     if ($entry eq "") {
  369.         paraprint <<EOF;
  370. No filename? I'll let you go back and choose an editor again.
  371. EOF
  372.         goto editor;
  373.     }
  374.  
  375.     unless (-f $entry and -r $entry) {
  376.         paraprint <<EOF;
  377. I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
  378. the file? If you don't want to send a file, just enter a blank line and you
  379. can get back to the editor selection.
  380. EOF
  381.         goto filename;
  382.     }
  383.     $file = $entry;
  384.     }
  385.  
  386.     # Generate report
  387.     open(REP,">$filename");
  388.     my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
  389.  
  390.     print REP <<EOF;
  391. This is a $reptype report for perl from $from,
  392. generated with the help of perlbug $Version running under perl $].
  393.  
  394. EOF
  395.  
  396.     if ($body) {
  397.     print REP $body;
  398.     } elsif ($usefile) {
  399.     open(F, "<$file")
  400.         or die "Unable to read report file from `$file': $!\n";
  401.     while (<F>) {
  402.         print REP $_
  403.     }
  404.     close(F);
  405.     } else {
  406.     print REP <<EOF;
  407.  
  408. -----------------------------------------------------------------
  409. [Please enter your report here]
  410.  
  411.  
  412.  
  413. [Please do not change anything below this line]
  414. -----------------------------------------------------------------
  415. EOF
  416.     }
  417.     Dump(*REP);
  418.     close(REP);
  419.  
  420.     # read in the report template once so that
  421.     # we can track whether the user does any editing.
  422.     # yes, *all* whitespace is ignored.
  423.     open(REP, "<$filename");
  424.     while (<REP>) {
  425.     s/\s+//g;
  426.     $REP{$_}++;
  427.     }
  428.     close(REP);
  429. } # sub Query
  430.  
  431. sub Dump {
  432.     local(*OUT) = @_;
  433.  
  434.     print REP "\n---\n";
  435.     print REP "This perlbug was built using Perl $config_tag1\n",
  436.         "It is being executed now by  Perl $config_tag2.\n\n"
  437.     if $config_tag2 ne $config_tag1;
  438.  
  439.     print OUT <<EOF;
  440. Site configuration information for perl $]:
  441.  
  442. EOF
  443.     if ($::Config{cf_by} and $::Config{cf_time}) {
  444.     print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
  445.     }
  446.     print OUT Config::myconfig;
  447.  
  448.     if (@patches) {
  449.     print OUT join "\n    ", "Locally applied patches:", @patches;
  450.     print OUT "\n";
  451.     };
  452.  
  453.     print OUT <<EOF;
  454.  
  455. ---
  456. \@INC for perl $]:
  457. EOF
  458.     for my $i (@INC) {
  459.     print OUT "    $i\n";
  460.     }
  461.  
  462.     print OUT <<EOF;
  463.  
  464. ---
  465. Environment for perl $]:
  466. EOF
  467.     for my $env (sort
  468.     (qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR),
  469.     grep /^(?:PERL|LC_)/, keys %ENV)
  470.     ) {
  471.     print OUT "    $env",
  472.         exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
  473.         "\n";
  474.     }
  475.     if ($verbose) {
  476.     print OUT "\nComplete configuration data for perl $]:\n\n";
  477.     my $value;
  478.     foreach (sort keys %::Config) {
  479.         $value = $::Config{$_};
  480.         $value =~ s/'/\\'/g;
  481.         print OUT "$_='$value'\n";
  482.     }
  483.     }
  484. } # sub Dump
  485.  
  486. sub Edit {
  487.     # Edit the report
  488.     if ($usefile || $body) {
  489.     paraprint <<EOF;
  490. Please make sure that the name of the editor you want to use is correct.
  491. EOF
  492.     print "Editor [$ed]: ";
  493.     my $entry =scalar <>;
  494.     chop $entry;
  495.     $ed = $entry unless $entry eq '';
  496.     }
  497.  
  498. tryagain:
  499.     my $sts = system("$ed $filename");
  500.     if ($sts) {
  501.     paraprint <<EOF;
  502. The editor you chose (`$ed') could apparently not be run!
  503. Did you mistype the name of your editor? If so, please
  504. correct it here, otherwise just press Enter.
  505. EOF
  506.     print "Editor [$ed]: ";
  507.     my $entry =scalar <>;
  508.     chop $entry;
  509.  
  510.     if ($entry ne "") {
  511.         $ed = $entry;
  512.         goto tryagain;
  513.     } else {
  514.         paraprint <<EOF;
  515. You may want to save your report to a file, so you can edit and mail it
  516. yourself.
  517. EOF
  518.     }
  519.     }
  520.  
  521.     return if ($ok and not $::opt_n) || $body;
  522.     # Check that we have a report that has some, eh, report in it.
  523.     my $unseen = 0;
  524.  
  525.     open(REP, "<$filename");
  526.     # a strange way to check whether any significant editing
  527.     # have been done: check whether any new non-empty lines
  528.     # have been added. Yes, the below code ignores *any* space
  529.     # in *any* line.
  530.     while (<REP>) {
  531.     s/\s+//g;
  532.     $unseen++ if $_ ne '' and not exists $REP{$_};
  533.     }
  534.  
  535.     while ($unseen == 0) {
  536.     paraprint <<EOF;
  537. I am sorry but it looks like you did not report anything.
  538. EOF
  539.     print "Action (Retry Edit/Cancel) ";
  540.     my ($action) = scalar(<>);
  541.     if ($action =~ /^[re]/i) { # <R>etry <E>dit
  542.         goto tryagain;
  543.     } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
  544.         Cancel();
  545.     }
  546.     }
  547. } # sub Edit
  548.  
  549. sub Cancel {
  550.     1 while unlink($filename);  # remove all versions under VMS
  551.     print "\nCancelling.\n";
  552.     exit(0);
  553. }
  554.  
  555. sub NowWhat {
  556.     # Report is done, prompt for further action
  557.     if( !$::opt_S ) {
  558.     while(1) {
  559.         paraprint <<EOF;
  560. Now that you have completed your report, would you like to send
  561. the message to $address$andcc, display the message on
  562. the screen, re-edit it, or cancel without sending anything?
  563. You may also save the message as a file to mail at another time.
  564. EOF
  565.       retry:
  566.         print "Action (Send/Display/Edit/Cancel/Save to File): ";
  567.         my $action = scalar <>;
  568.         chop $action;
  569.  
  570.         if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
  571.         print "\n\nName of file to save message in [perlbug.rep]: ";
  572.         my $file = scalar <>;
  573.         chop $file;
  574.         $file = "perlbug.rep" if $file eq "";
  575.  
  576.         unless (open(FILE, ">$file")) {
  577.             print "\nError opening $file: $!\n\n";
  578.             goto retry;
  579.         }
  580.         open(REP, "<$filename");
  581.         print FILE "To: $address\nSubject: $subject\n";
  582.         print FILE "Cc: $cc\n" if $cc;
  583.         print FILE "Reply-To: $from\n" if $from;
  584.         print FILE "\n";
  585.         while (<REP>) { print FILE }
  586.         close(REP);
  587.         close(FILE);
  588.  
  589.         print "\nMessage saved in `$file'.\n";
  590.         exit;
  591.         } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
  592.         # Display the message
  593.         open(REP, "<$filename");
  594.         while (<REP>) { print $_ }
  595.         close(REP);
  596.         } elsif ($action =~ /^se/i) { # <S>end
  597.         # Send the message
  598.         print "Are you certain you want to send this message?\n"
  599.             . 'Please type "yes" if you are: ';
  600.         my $reply = scalar <STDIN>;
  601.         chop $reply;
  602.         if ($reply eq "yes") {
  603.             last;
  604.         } else {
  605.             paraprint <<EOF;
  606. That wasn't a clear "yes", so I won't send your message. If you are sure
  607. your message should be sent, type in "yes" (without the quotes) at the
  608. confirmation prompt.
  609. EOF
  610.         }
  611.         } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
  612.         # edit the message
  613.         Edit();
  614.         } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
  615.         Cancel();
  616.         } elsif ($action =~ /^s/) {
  617.         paraprint <<EOF;
  618. I'm sorry, but I didn't understand that. Please type "send" or "save".
  619. EOF
  620.         }
  621.     }
  622.     }
  623. } # sub NowWhat
  624.  
  625. sub Send {
  626.     # Message has been accepted for transmission -- Send the message
  627.     if ($outfile) {
  628.     open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
  629.     goto sendout;
  630.     }
  631.     if ($::HaveSend) {
  632.     $msg = new Mail::Send Subject => $subject, To => $address;
  633.     $msg->cc($cc) if $cc;
  634.     $msg->add("Reply-To",$from) if $from;
  635.  
  636.     $fh = $msg->open;
  637.     open(REP, "<$filename");
  638.     while (<REP>) { print $fh $_ }
  639.     close(REP);
  640.     $fh->close;
  641.  
  642.     print "\nMessage sent.\n";
  643.     } elsif ($Is_VMS) {
  644.     if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
  645.          ($cc      =~ /@/ and $cc      !~ /^\w+%"/) ) {
  646.         my $prefix;
  647.         foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
  648.         $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
  649.         }
  650.         $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
  651.         $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
  652.     }
  653.     $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
  654.     my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
  655.     if ($sts) {
  656.         die <<EOF;
  657. Can't spawn off mail
  658.     (leaving bug report in $filename): $sts
  659. EOF
  660.     }
  661.     } else {
  662.     my $sendmail = "";
  663.     for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
  664.         $sendmail = $_, last if -e $_;
  665.     }
  666.     if ($^O eq 'os2' and $sendmail eq "") {
  667.         my $path = $ENV{PATH};
  668.         $path =~ s:\\:/: ;
  669.         my @path = split /$Config{'path_sep'}/, $path;
  670.         for (@path) {
  671.         $sendmail = "$_/sendmail", last if -e "$_/sendmail";
  672.         $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
  673.         }
  674.     }
  675.  
  676.     paraprint(<<"EOF"), die "\n" if $sendmail eq "";
  677. I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
  678. the perl package Mail::Send has not been installed, so I can't send your bug
  679. report. We apologize for the inconvenience.
  680.  
  681. So you may attempt to find some way of sending your message, it has
  682. been left in the file `$filename'.
  683. EOF
  684.     open(SENDMAIL, "|$sendmail -t") || die "'|$sendmail -t' failed: $!";
  685. sendout:
  686.     print SENDMAIL "To: $address\n";
  687.     print SENDMAIL "Subject: $subject\n";
  688.     print SENDMAIL "Cc: $cc\n" if $cc;
  689.     print SENDMAIL "Reply-To: $from\n" if $from;
  690.     print SENDMAIL "\n\n";
  691.     open(REP, "<$filename");
  692.     while (<REP>) { print SENDMAIL $_ }
  693.     close(REP);
  694.  
  695.     if (close(SENDMAIL)) {
  696.         printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
  697.     } else {
  698.         warn "\nSendmail returned status '", $? >> 8, "'\n";
  699.     }
  700.     }
  701.     1 while unlink($filename);  # remove all versions under VMS
  702. } # sub Send
  703.  
  704. sub Help {
  705.     print <<EOF;
  706.  
  707. A program to help generate bug reports about perl5, and mail them.
  708. It is designed to be used interactively. Normally no arguments will
  709. be needed.
  710.  
  711. Usage:
  712. $0  [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
  713.     [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
  714. $0  [-v] [-r returnaddress] [-ok | -okay | -nok | -nokay]
  715.  
  716. Simplest usage:  run "$0", and follow the prompts.
  717.  
  718. Options:
  719.  
  720.   -v    Include Verbose configuration data in the report
  721.   -f    File containing the body of the report. Use this to
  722.         quickly send a prepared message.
  723.   -F    File to output the resulting mail message to, instead of mailing.
  724.   -S    Send without asking for confirmation.
  725.   -a    Address to send the report to. Defaults to `$address'.
  726.   -c    Address to send copy of report to. Defaults to `$cc'.
  727.   -C    Don't send copy to administrator.
  728.   -s    Subject to include with the message. You will be prompted
  729.         if you don't supply one on the command line.
  730.   -b    Body of the report. If not included on the command line, or
  731.         in a file with -f, you will get a chance to edit the message.
  732.   -r    Your return address. The program will ask you to confirm
  733.         this if you don't give it here.
  734.   -e    Editor to use.
  735.   -t    Test mode. The target address defaults to `$testaddress'.
  736.   -d    Data mode (the default if you redirect or pipe output.)
  737.         This prints out your configuration data, without mailing
  738.         anything. You can use this with -v to get more complete data.
  739.   -ok   Report successful build on this system to perl porters
  740.         (use alone or with -v). Only use -ok if *everything* was ok:
  741.         if there were *any* problems at all, use -nok.
  742.   -okay As -ok but allow report from old builds.
  743.   -nok  Report unsuccessful build on this system to perl porters
  744.         (use alone or with -v). You must describe what went wrong
  745.         in the body of the report which you will be asked to edit.
  746.   -nokay As -nok but allow report from old builds.
  747.   -h    Print this help message.
  748.  
  749. EOF
  750. }
  751.  
  752. sub filename {
  753.     my $dir = $Is_VMS ? 'sys$scratch:'
  754.     : ($Is_MSWin32 && $ENV{'TEMP'}) ? $ENV{'TEMP'}
  755.     : '/tmp/';
  756.     $filename = "bugrep0$$";
  757.     $dir .= "\\" if $Is_MSWin32 and $dir !~ m|[\\/]$|;
  758.     $filename++ while -e "$dir$filename";
  759.     $filename = "$dir$filename";
  760. }
  761.  
  762. sub paraprint {
  763.     my @paragraphs = split /\n{2,}/, "@_";
  764.     print "\n\n";
  765.     for (@paragraphs) {   # implicit local $_
  766.     s/(\S)\s*\n/$1 /g;
  767.     write;
  768.     print "\n";
  769.     }
  770. }
  771.  
  772. format STDOUT =
  773. ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
  774. $_
  775. .
  776.  
  777. __END__
  778.  
  779. =head1 NAME
  780.  
  781. perlbug - how to submit bug reports on Perl
  782.  
  783. =head1 SYNOPSIS
  784.  
  785. B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
  786. S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
  787. S<[ B<-r> I<returnaddress> ]>
  788. S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
  789. S<[ B<-S> ]> S<[ B<-t> ]>  S<[ B<-d> ]>  S<[ B<-h> ]>
  790.  
  791. B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
  792. S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
  793.  
  794. =head1 DESCRIPTION
  795.  
  796. A program to help generate bug reports about perl or the modules that
  797. come with it, and mail them.
  798.  
  799. If you have found a bug with a non-standard port (one that was not part
  800. of the I<standard distribution>), a binary distribution, or a
  801. non-standard module (such as Tk, CGI, etc), then please see the
  802. documentation that came with that distribution to determine the correct
  803. place to report bugs.
  804.  
  805. C<perlbug> is designed to be used interactively. Normally no arguments
  806. will be needed.  Simply run it, and follow the prompts.
  807.  
  808. If you are unable to run B<perlbug> (most likely because you don't have
  809. a working setup to send mail that perlbug recognizes), you may have to
  810. compose your own report, and email it to B<perlbug@perl.com>.  You might
  811. find the B<-d> option useful to get summary information in that case.
  812.  
  813. In any case, when reporting a bug, please make sure you have run through
  814. this checklist:
  815.  
  816. =over 4
  817.  
  818. =item What version of perl you are running?
  819.  
  820. Type C<perl -v> at the command line to find out.
  821.  
  822. =item Are you running the latest released version of perl?
  823.  
  824. Look at http://www.perl.com/ to find out.  If it is not the latest
  825. released version, get that one and see whether your bug has been
  826. fixed.  Note that bug reports about old versions of perl, especially
  827. those prior to the 5.0 release, are likely to fall upon deaf ears.
  828. You are on your own if you continue to use perl1 .. perl4.
  829.  
  830. =item Are you sure what you have is a bug?
  831.  
  832. A significant number of the bug reports we get turn out to be documented
  833. features in perl.  Make sure the behavior you are witnessing doesn't fall
  834. under that category, by glancing through the documentation that comes
  835. with perl (we'll admit this is no mean task, given the sheer volume of
  836. it all, but at least have a look at the sections that I<seem> relevant).
  837.  
  838. Be aware of the familiar traps that perl programmers of various hues
  839. fall into.  See L<perltrap>.
  840.  
  841. Try to study the problem under the perl debugger, if necessary.
  842. See L<perldebug>.
  843.  
  844. =item Do you have a proper test case?
  845.  
  846. The easier it is to reproduce your bug, the more likely it will be
  847. fixed, because if no one can duplicate the problem, no one can fix it.
  848. A good test case has most of these attributes: fewest possible number
  849. of lines; few dependencies on external commands, modules, or
  850. libraries; runs on most platforms unimpeded; and is self-documenting.
  851.  
  852. A good test case is almost always a good candidate to be on the perl
  853. test suite.  If you have the time, consider making your test case so
  854. that it will readily fit into the standard test suite.
  855.  
  856. =item Can you describe the bug in plain English?
  857.  
  858. The easier it is to understand a reproducible bug, the more likely it
  859. will be fixed.  Anything you can provide by way of insight into the
  860. problem helps a great deal.  In other words, try to analyse the
  861. problem to the extent you feel qualified and report your discoveries.
  862.  
  863. =item Can you fix the bug yourself?
  864.  
  865. A bug report which I<includes a patch to fix it> will almost
  866. definitely be fixed.  Use the C<diff> program to generate your patches
  867. (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
  868. package, so you should be able to get it from any of the GNU software
  869. repositories).  If you do submit a patch, the cool-dude counter at
  870. perlbug@perl.com will register you as a savior of the world.  Your
  871. patch may be returned with requests for changes, or requests for more
  872. detailed explanations about your fix.
  873.  
  874. Here are some clues for creating quality patches: Use the B<-c> or
  875. B<-u> switches to the diff program (to create a so-called context or
  876. unified diff).  Make sure the patch is not reversed (the first
  877. argument to diff is typically the original file, the second argument
  878. your changed file).  Make sure you test your patch by applying it with
  879. the C<patch> program before you send it on its way.  Try to follow the
  880. same style as the code you are trying to patch.  Make sure your patch
  881. really does work (C<make test>, if the thing you're patching supports
  882. it).
  883.  
  884. =item Can you use C<perlbug> to submit the report?
  885.  
  886. B<perlbug> will, amongst other things, ensure your report includes
  887. crucial information about your version of perl.  If C<perlbug> is unable
  888. to mail your report after you have typed it in, you may have to compose
  889. the message yourself, add the output produced by C<perlbug -d> and email
  890. it to B<perlbug@perl.com>.  If, for some reason, you cannot run
  891. C<perlbug> at all on your system, be sure to include the entire output
  892. produced by running C<perl -V> (note the uppercase V).
  893.  
  894. =back
  895.  
  896. Having done your bit, please be prepared to wait, to be told the bug
  897. is in your code, or even to get no reply at all.  The perl maintainers
  898. are busy folks, so if your problem is a small one or if it is difficult
  899. to understand or already known, they may not respond with a personal reply.
  900. If it is important to you that your bug be fixed, do monitor the
  901. C<Changes> file in any development releases since the time you submitted
  902. the bug, and encourage the maintainers with kind words (but never any
  903. flames!).  Feel free to resend your bug report if the next released
  904. version of perl comes out and your bug is still present.
  905.  
  906. =head1 OPTIONS
  907.  
  908. =over 8
  909.  
  910. =item B<-a>
  911.  
  912. Address to send the report to.  Defaults to `perlbug@perl.com'.
  913.  
  914. =item B<-b>
  915.  
  916. Body of the report.  If not included on the command line, or
  917. in a file with B<-f>, you will get a chance to edit the message.
  918.  
  919. =item B<-C>
  920.  
  921. Don't send copy to administrator.
  922.  
  923. =item B<-c>
  924.  
  925. Address to send copy of report to.  Defaults to the address of the
  926. local perl administrator (recorded when perl was built).
  927.  
  928. =item B<-d>
  929.  
  930. Data mode (the default if you redirect or pipe output).  This prints out
  931. your configuration data, without mailing anything.  You can use this
  932. with B<-v> to get more complete data.
  933.  
  934. =item B<-e>
  935.  
  936. Editor to use.
  937.  
  938. =item B<-f>
  939.  
  940. File containing the body of the report.  Use this to quickly send a
  941. prepared message.
  942.  
  943. =item B<-F>
  944.  
  945. File to output the results to instead of sending as an email. Useful
  946. particularly when running perlbug on a machine with no direct internet
  947. connection.
  948.  
  949. =item B<-h>
  950.  
  951. Prints a brief summary of the options.
  952.  
  953. =item B<-ok>
  954.  
  955. Report successful build on this system to perl porters. Forces B<-S>
  956. and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
  957. prompts for a return address if it cannot guess it (for use with
  958. B<make>). Honors return address specified with B<-r>.  You can use this
  959. with B<-v> to get more complete data.   Only makes a report if this
  960. system is less than 60 days old.
  961.  
  962. =item B<-okay>
  963.  
  964. As B<-ok> except it will report on older systems.
  965.  
  966. =item B<-nok>
  967.  
  968. Report unsuccessful build on this system.  Forces B<-C>.  Forces and
  969. supplies a value for B<-s>, then requires you to edit the report
  970. and say what went wrong.  Alternatively, a prepared report may be
  971. supplied using B<-f>.  Only prompts for a return address if it
  972. cannot guess it (for use with B<make>). Honors return address
  973. specified with B<-r>.  You can use this with B<-v> to get more
  974. complete data.  Only makes a report if this system is less than 60
  975. days old.
  976.  
  977. =item B<-nokay>
  978.  
  979. As B<-nok> except it will report on older systems.
  980.  
  981. =item B<-r>
  982.  
  983. Your return address.  The program will ask you to confirm its default
  984. if you don't use this option.
  985.  
  986. =item B<-S>
  987.  
  988. Send without asking for confirmation.
  989.  
  990. =item B<-s>
  991.  
  992. Subject to include with the message.  You will be prompted if you don't
  993. supply one on the command line.
  994.  
  995. =item B<-t>
  996.  
  997. Test mode.  The target address defaults to `perlbug-test@perl.com'.
  998.  
  999. =item B<-v>
  1000.  
  1001. Include verbose configuration data in the report.
  1002.  
  1003. =back
  1004.  
  1005. =head1 AUTHORS
  1006.  
  1007. Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
  1008. by Gurusamy Sarathy (E<lt>gsar@umich.eduE<gt>), Tom Christiansen
  1009. (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
  1010. Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
  1011. (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>)
  1012. and Hugo van der Sanden (E<lt>hv@crypt0.demon.co.ukE<gt>).
  1013.  
  1014. =head1 SEE ALSO
  1015.  
  1016. perl(1), perldebug(1), perltrap(1), diff(1), patch(1)
  1017.  
  1018. =head1 BUGS
  1019.  
  1020. None known (guess what must have been used to report them?)
  1021.  
  1022. =cut
  1023.  
  1024.